Introduction to Manual¶
Manual Contents¶
The contents of the CUBRID Database Management System (CUBRID DBMS) product manual are as follows:
- Introduction to CUBRID: This chapter provides a description of the structure and characteristics of the CUBRID DBMS.
- Getting Started: The "Getting Started with CUBRID" provides users with a brief explanation on what to do when first starting CUBRID. The chapter contains information on how to install and execute the system, used ports on accessing to CUBRID and provides simple explanations on the CUBRID query tools.
- CSQL Interpreter: CSQL is an application that allows you to use SQL statements through a command-driven interface. This chapter explains how to use the CSQL Interpreter and associated commands.
- CUBRID SQL Guide: This chapter describes SQL syntaxes such as data types, functions and operators, data retrieval or table manipulation. The chapter also provides SQL syntaxes used for indexes, triggers, partitioning, serial and user information changes, etc.
- Administrator's Guide: This chapter provides instructions on how to create, drop, back up, restore and migrate a database, configuring globalization, and executing CUBRID HA and CUBRID SHARD. Also it includes instructions on how to use the cubrid utility, which starts and stops the server, broker, and CUBRID Manager server, etc. Also, this chapter provides instructions on setting system parameters that may influence the performance. It provides information on how to use the configuration file for the server and broker, and describes the meaning of each parameter.
- API Reference: The "Performance Tuning" chapter provides instructions on setting system parameters that may influence the performance. This chapter provides information on how to use the configuration file for the server and broker, and describes the meaning of each parameter.
- Release Notes: This chapter provides a description of additions, changes, improvements and bug fixes.
Glossary¶
CUBRID is an object-relational database management system (ORDBMS), which supports object-oriented concepts such as inheritance. In this manual, relational database terminologies are also used along with object-oriented terminologies for better understanding. Object-oriented terminologies such as class, instance and attribute is used to describe concepts including inheritance, and relational database terminologies are mainly used to describe common SQL syntax.
| Relational Database | CUBRID |
|---|---|
| table | class, table |
| column | attribute, column |
| record | instance, record |
| data type | domain, data type |
Manual Conventions¶
The following table provides conventions on definitions used in the CUBRID Database Management System product manual to identify "statements," "commands" and "reference within texts."
| Convention | Description | Example |
|---|---|---|
| Italics | Italics type represents variable names and user-defined values (system, database, table, column, file) in examples. | persistent : stringVariableName |
| Boldface | Boldface type represents names such as the member function name, class name, constants, CUBRID keyword or names such as other required characters. | fetch ( ) member function |
| Constant Width | Constant Width type represents segments of code example or describes a command's execution and results. | csql database_name |
| UPPER-CASE | UPPER-CASE represents the CUBRID keyword (see Boldface ). | SELECT |
| Single Quotes (' ') | Single quotes (' ') are used with braces and brackets and represent the necessary sections of a syntax. Single quotes are also used to enclose strings. | {'{' const_list '}'} |
| Brackets ([ ]) | Brackets ([ ]) represents optional parameters or keywords. | [ ONLY ] |
| Vertical bar ( | ) | Vertical bar (|) represents that one or another option can be specified. | [ COLUMN | ATTRIBUTE ] |
| A parameter enclosed by braces ({ }) | A parameter enclosed by braces represents that one of those parameters must be specified in a statement syntax. | CREATE { TABLE | CLASS } |
| A value enclosed by braces ({ }) | A value enclosed by braces an element consisting of collection. | {2, 4, 6} |
| Braces with ellipsis({ }...) | Braces before an ellipsis represents that a parameter can be repeated. | {, class_name }... |
| Angle brackets(< >) | Angle brackets represent a single key or a series of key strokes. | <Ctrl+n> |
Version Name and Version String Conventions¶
Rules for version naming and string since CUBRID 9.0 are as follows:
- Version name: CUBRID x.x Patch x (major version, minor version, patch version if necessary) CUBRID 9.0 Patch 1 (CUBRID 9.0 P1 in short)
- Version string: x.x.x.x (major version, minor version, patch version, build number) 9.0.1.0012
Rules for version naming and string before CUBRID 9.0 are as follows:
- Version name: CUBRID 2008 Rx.x Patch x (2008 for major version, minor version, patch version, build number) CUBRID 2008 R4.1 Patch 1
- Version string: 8.x.x.x (major version, minor version, patch version, build number) 8.4.1.1001